/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.qos.impl;

import java.security.PrivateKey;
import java.util.Properties;

import javax.crypto.SecretKey;

import org.apache.log4j.Logger;

import cgl.narada.event.TemplateInfo;
import cgl.narada.service.ServiceException;
import cgl.narada.service.qos.ProducerConstraints;
import cgl.narada.service.qos.QosIdentifiers;
import cgl.narada.service.security.impl.EntityOperationsImpl;
import cgl.narada.service.security.kmc.SignedSecurityToken;

/**
 * Allows a consumer to specify QosConstraints on the sending or receiving of
 * events conforming to a given profile
 * 
 * @author Shrideep Pallickara $Date$ $Revision$
 */

public class ProducerConstraintsImpl implements ProducerConstraints {

    static Logger log = Logger.getLogger("ProducerConstraintsImpl");

    private int entityId = 0;
    private int producerId = 0;

    private TemplateInfo templateInfo;

    private boolean sendSecurely = false;
    private boolean sendWithMessageDigest = false;
    private boolean sendAfterPayloadCompression = false;
    private boolean sendReliably = false;
    private boolean sendAfterFragmentation = false;

    private Properties fragmentationProperties;
    private Properties compressionProperties;

    // HG:
    private SignedSecurityToken signedSecurityToken = null;
    private SecretKey secretKey = null;
    private PrivateKey privKey = null;
    private Properties securityProps = null;

    // ---

    public ProducerConstraintsImpl(int entityId, int producerId,
            TemplateInfo templateInfo) {
        this.entityId = entityId;
        this.producerId = producerId;
        this.templateInfo = templateInfo;
    }

    public TemplateInfo getTemplateInfo() {
        return templateInfo;
    }

    public int getProducerId() {
        return producerId;
    }

    public int getEntityId() {
        return entityId;
    }

    public void setSendSecurely() {
        sendSecurely = true;
    }

    public void setSendReliably() {
        sendReliably = true;
    }

    public void setSendWithMessageDigest() {
        sendWithMessageDigest = true;
    }

    public void setSendAfterPayloadCompression(Properties compressionProperties) {
        this.compressionProperties = compressionProperties;
        sendAfterPayloadCompression = true;
    }

    public Properties getCompressionParams() {
        return compressionProperties;
    }

    public void setSendAfterFragmentation(Properties fragmentationProperties) {
        this.fragmentationProperties = fragmentationProperties;
        sendAfterFragmentation = true;
    }

    public Properties getFragmentationParams() {
        return fragmentationProperties;
    }

    public boolean isSendSecurely() {
        return sendSecurely;
    }

    public boolean isSendReliably() {
        return sendReliably;
    }

    public boolean isSendWithMessageDigest() {
        return sendWithMessageDigest;
    }

    public boolean isSendAfterPayloadCompression() {
        return sendAfterPayloadCompression;
    }

    public boolean isSendAfterFragmentation() {
        return sendAfterFragmentation;
    }

    public boolean hasSatisfiedSpecifiedConstraints(QosIdentifiers identifiers) {

        boolean satisfied = true;

        if (sendReliably) {
            if (!identifiers.isArchived()) {
                satisfied = false;
            }
        }

        return satisfied;

    }

    /** end hasSatisfiedSpecifiedConstraints */

    // HG:
    /**
     * Sets the security token for publishing events over a secure topic<br>
     * NOTE: This is a non-optional requirement for subscribing to secure topics
     * 
     * @param sst -
     *            The signed security token as obtained from a KMC
     * @param key -
     *            The secret key associated with the topic. This will be used to
     *            encrypt the payload
     */
    public void setSecurityToken(SignedSecurityToken sst, SecretKey key,
            PrivateKey privKey, Properties props) throws ServiceException {

        if (sst == null || key == null)
            throw new ServiceException(
                    "Signed Security token OR Secret Key MUST not be null");
        this.signedSecurityToken = sst;
        this.secretKey = key;
        this.privKey = privKey;
        this.securityProps = props;

        setSendSecurely();
    }

    public SignedSecurityToken getSignedSecurityToken() {
        return this.signedSecurityToken;
    }

    public byte[] signPayload(byte[] payload, String useAlgorithm) {
        byte[] signature;

        try {
            EntityOperationsImpl entityOperations = new EntityOperationsImpl();
            signature = entityOperations.signPayload(privKey, useAlgorithm,
                    "BC", payload);
        } catch (ServiceException e) {
            log.error("Exception when generating Signature: ", e);
            return null;
        }
        return signature;
    }

    public SecretKey getSecretKey() {
        return this.secretKey;
    }

    public Properties getEncryptionProperties() {
        return this.securityProps;
    }

    // ---
}
